<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>PropertyConfigurator xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../apidocs/org/apache/log4j/PropertyConfigurator.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
<a name="8" href="#8">8</a>   <em class="comment"> * </em>
<a name="9" href="#9">9</a>   <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="10" href="#10">10</a>  <em class="comment"> * </em>
<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
<a name="16" href="#16">16</a>  <em class="comment"> */</em>
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <em class="comment">// Contibutors: "Luke Blanshard" &lt;Luke@quiq.com></em>
<a name="20" href="#20">20</a>  <em class="comment">//              "Mark DONSZELMANN" &lt;Mark.Donszelmann@cern.ch></em>
<a name="21" href="#21">21</a>  <em class="comment">//               Anders Kristensen &lt;akristensen@dynamicsoft.com></em>
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>package</strong> org.apache.log4j;
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  <strong>import</strong> org.apache.log4j.config.PropertySetter;
<a name="26" href="#26">26</a>  <strong>import</strong> org.apache.log4j.helpers.FileWatchdog;
<a name="27" href="#27">27</a>  <strong>import</strong> org.apache.log4j.helpers.LogLog;
<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.log4j.helpers.OptionConverter;
<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.log4j.or.RendererMap;
<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.log4j.spi.Configurator;
<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.log4j.spi.LoggerFactory;
<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.log4j.spi.LoggerRepository;
<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.log4j.spi.OptionHandler;
<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.log4j.spi.RendererSupport;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  <strong>import</strong> java.io.FileInputStream;
<a name="37" href="#37">37</a>  <strong>import</strong> java.io.InputStream;
<a name="38" href="#38">38</a>  <strong>import</strong> java.util.Enumeration;
<a name="39" href="#39">39</a>  <strong>import</strong> java.util.Hashtable;
<a name="40" href="#40">40</a>  <strong>import</strong> java.util.Properties;
<a name="41" href="#41">41</a>  <strong>import</strong> java.util.StringTokenizer;
<a name="42" href="#42">42</a>  
<a name="43" href="#43">43</a>  <em>/**<em>*</em></em>
<a name="44" href="#44">44</a>  <em>   Allows the configuration of log4j from an external file.  See</em>
<a name="45" href="#45">45</a>  <em>   &lt;b>{@link #doConfigure(String, LoggerRepository)}&lt;/b> for the</em>
<a name="46" href="#46">46</a>  <em>   expected format.</em>
<a name="47" href="#47">47</a>  
<a name="48" href="#48">48</a>  <em>   &lt;p>It is sometimes useful to see how log4j is reading configuration</em>
<a name="49" href="#49">49</a>  <em>   files. You can enable log4j internal logging by defining the</em>
<a name="50" href="#50">50</a>  <em>   &lt;b>log4j.debug&lt;/b> variable.</em>
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>  <em>   &lt;P>As of log4j version 0.8.5, at class initialization time class,</em>
<a name="53" href="#53">53</a>  <em>   the file &lt;b>log4j.properties&lt;/b> will be searched from the search</em>
<a name="54" href="#54">54</a>  <em>   path used to load classes. If the file can be found, then it will</em>
<a name="55" href="#55">55</a>  <em>   be fed to the {@link PropertyConfigurator#configure(java.net.URL)}</em>
<a name="56" href="#56">56</a>  <em>   method.</em>
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>  <em>   &lt;p>The &lt;code>PropertyConfigurator&lt;/code> does not handle the</em>
<a name="59" href="#59">59</a>  <em>   advanced configuration features supported by the {@link</em>
<a name="60" href="#60">60</a>  <em>   org.apache.log4j.xml.DOMConfigurator DOMConfigurator} such as</em>
<a name="61" href="#61">61</a>  <em>   support for {@link org.apache.log4j.spi.Filter Filters}, custom</em>
<a name="62" href="#62">62</a>  <em>   {@link org.apache.log4j.spi.ErrorHandler ErrorHandlers}, nested</em>
<a name="63" href="#63">63</a>  <em>   appenders such as the {@link org.apache.log4j.AsyncAppender</em>
<a name="64" href="#64">64</a>  <em>   AsyncAppender}, etc.</em>
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>  <em>   &lt;p>All option &lt;em>values&lt;/em> admit variable substitution. The</em>
<a name="67" href="#67">67</a>  <em>   syntax of variable substitution is similar to that of Unix</em>
<a name="68" href="#68">68</a>  <em>   shells. The string between an opening &lt;b>&amp;quot;${&amp;quot;&lt;/b> and</em>
<a name="69" href="#69">69</a>  <em>   closing &lt;b>&amp;quot;}&amp;quot;&lt;/b> is interpreted as a key. The value of</em>
<a name="70" href="#70">70</a>  <em>   the substituted variable can be defined as a system property or in</em>
<a name="71" href="#71">71</a>  <em>   the configuration file itself. The value of the key is first</em>
<a name="72" href="#72">72</a>  <em>   searched in the system properties, and if not found there, it is</em>
<a name="73" href="#73">73</a>  <em>   then searched in the configuration file being parsed.  The</em>
<a name="74" href="#74">74</a>  <em>   corresponding value replaces the ${variableName} sequence. For</em>
<a name="75" href="#75">75</a>  <em>   example, if &lt;code>java.home&lt;/code> system property is set to</em>
<a name="76" href="#76">76</a>  <em>   &lt;code>/home/xyz&lt;/code>, then every occurrence of the sequence</em>
<a name="77" href="#77">77</a>  <em>   &lt;code>${java.home}&lt;/code> will be interpreted as</em>
<a name="78" href="#78">78</a>  <em>   &lt;code>/home/xyz&lt;/code>.</em>
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>  <em>   @author Ceki G&amp;uuml;lc&amp;uuml;</em>
<a name="82" href="#82">82</a>  <em>   @author Anders Kristensen</em>
<a name="83" href="#83">83</a>  <em>   @since 0.8.1 */</em>
<a name="84" href="#84">84</a>  <strong>public</strong> <strong>class</strong> <a href="../../../org/apache/log4j/PropertyConfigurator.html">PropertyConfigurator</a> implements <a href="../../../org/apache/log4j/spi/Configurator.html">Configurator</a> {
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>    <em>/**<em>*</em></em>
<a name="87" href="#87">87</a>  <em>     Used internally to keep track of configured appenders.</em>
<a name="88" href="#88">88</a>  <em>   */</em>
<a name="89" href="#89">89</a>    <strong>protected</strong> Hashtable registry = <strong>new</strong> Hashtable(11);
<a name="90" href="#90">90</a>    <strong>protected</strong> <a href="../../../org/apache/log4j/spi/LoggerFactory.html">LoggerFactory</a> loggerFactory = <strong>new</strong> <a href="../../../org/apache/log4j/DefaultCategoryFactory.html">DefaultCategoryFactory</a>();
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>    <strong>static</strong> <strong>final</strong> String      CATEGORY_PREFIX = <span class="string">"log4j.category."</span>;
<a name="93" href="#93">93</a>    <strong>static</strong> <strong>final</strong> String      LOGGER_PREFIX   = <span class="string">"log4j.logger."</span>;
<a name="94" href="#94">94</a>    <strong>static</strong> <strong>final</strong> String       FACTORY_PREFIX = <span class="string">"log4j.factory"</span>;
<a name="95" href="#95">95</a>    <strong>static</strong> <strong>final</strong> String    ADDITIVITY_PREFIX = <span class="string">"log4j.additivity."</span>;
<a name="96" href="#96">96</a>    <strong>static</strong> <strong>final</strong> String ROOT_CATEGORY_PREFIX = <span class="string">"log4j.rootCategory"</span>;
<a name="97" href="#97">97</a>    <strong>static</strong> <strong>final</strong> String ROOT_LOGGER_PREFIX   = <span class="string">"log4j.rootLogger"</span>;
<a name="98" href="#98">98</a>    <strong>static</strong> <strong>final</strong> String      APPENDER_PREFIX = <span class="string">"log4j.appender."</span>;
<a name="99" href="#99">99</a>    <strong>static</strong> <strong>final</strong> String      RENDERER_PREFIX = <span class="string">"log4j.renderer."</span>;
<a name="100" href="#100">100</a>   <strong>static</strong> <strong>final</strong> String      THRESHOLD_PREFIX = <span class="string">"log4j.threshold"</span>;
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>   <em>/**<em>* Key for specifying the {@link org.apache.log4j.spi.LoggerFactory</em></em>
<a name="103" href="#103">103</a> <em>      LoggerFactory}.  Currently set to "&lt;code>log4j.loggerFactory&lt;/code>".  */</em>
<a name="104" href="#104">104</a>   <strong>public</strong> <strong>static</strong> <strong>final</strong> String LOGGER_FACTORY_KEY = <span class="string">"log4j.loggerFactory"</span>;
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>     <em>/**<em>*</em></em>
<a name="107" href="#107">107</a> <em>     * If property set to true, then hierarchy will be reset before configuration.</em>
<a name="108" href="#108">108</a> <em>     */</em>
<a name="109" href="#109">109</a>   <strong>private</strong> <strong>static</strong> <strong>final</strong> String RESET_KEY = <span class="string">"log4j.reset"</span>;
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>   <strong>static</strong> <strong>final</strong> <strong>private</strong> String INTERNAL_ROOT_NAME = <span class="string">"root"</span>;
<a name="112" href="#112">112</a> 
<a name="113" href="#113">113</a>   <em>/**<em>*</em></em>
<a name="114" href="#114">114</a> <em>    Read configuration from a file. &lt;b>The existing configuration is</em>
<a name="115" href="#115">115</a> <em>    not cleared nor reset.&lt;/b> If you require a different behavior,</em>
<a name="116" href="#116">116</a> <em>    then call {@link  LogManager#resetConfiguration</em>
<a name="117" href="#117">117</a> <em>    resetConfiguration} method before calling</em>
<a name="118" href="#118">118</a> <em>    &lt;code>doConfigure&lt;/code>.</em>
<a name="119" href="#119">119</a> 
<a name="120" href="#120">120</a> <em>    &lt;p>The configuration file consists of statements in the format</em>
<a name="121" href="#121">121</a> <em>    &lt;code>key=value&lt;/code>. The syntax of different configuration</em>
<a name="122" href="#122">122</a> <em>    elements are discussed below.</em>
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a> <em>    &lt;h3>Repository-wide threshold&lt;/h3></em>
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a> <em>    &lt;p>The repository-wide threshold filters logging requests by level</em>
<a name="127" href="#127">127</a> <em>    regardless of logger. The syntax is:</em>
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a> <em>    &lt;pre></em>
<a name="130" href="#130">130</a> <em>    log4j.threshold=[level]</em>
<a name="131" href="#131">131</a> <em>    &lt;/pre></em>
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a> <em>    &lt;p>The level value can consist of the string values OFF, FATAL,</em>
<a name="134" href="#134">134</a> <em>    ERROR, WARN, INFO, DEBUG, ALL or a &lt;em>custom level&lt;/em> value. A</em>
<a name="135" href="#135">135</a> <em>    custom level value can be specified in the form</em>
<a name="136" href="#136">136</a> <em>    level#classname. By default the repository-wide threshold is set</em>
<a name="137" href="#137">137</a> <em>    to the lowest possible value, namely the level &lt;code>ALL&lt;/code>.</em>
<a name="138" href="#138">138</a> <em>    &lt;/p></em>
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a> 
<a name="141" href="#141">141</a> <em>    &lt;h3>Appender configuration&lt;/h3></em>
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a> <em>    &lt;p>Appender configuration syntax is:</em>
<a name="144" href="#144">144</a> <em>    &lt;pre></em>
<a name="145" href="#145">145</a> <em>    # For appender named &lt;i>appenderName&lt;/i>, set its class.</em>
<a name="146" href="#146">146</a> <em>    # Note: The appender name can contain dots.</em>
<a name="147" href="#147">147</a> <em>    log4j.appender.appenderName=fully.qualified.name.of.appender.class</em>
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a> <em>    # Set appender specific options.</em>
<a name="150" href="#150">150</a> <em>    log4j.appender.appenderName.option1=value1</em>
<a name="151" href="#151">151</a> <em>    ...</em>
<a name="152" href="#152">152</a> <em>    log4j.appender.appenderName.optionN=valueN</em>
<a name="153" href="#153">153</a> <em>    &lt;/pre></em>
<a name="154" href="#154">154</a> 
<a name="155" href="#155">155</a> <em>    For each named appender you can configure its {@link Layout}. The</em>
<a name="156" href="#156">156</a> <em>    syntax for configuring an appender's layout is:</em>
<a name="157" href="#157">157</a> <em>    &lt;pre></em>
<a name="158" href="#158">158</a> <em>    log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class</em>
<a name="159" href="#159">159</a> <em>    log4j.appender.appenderName.layout.option1=value1</em>
<a name="160" href="#160">160</a> <em>    ....</em>
<a name="161" href="#161">161</a> <em>    log4j.appender.appenderName.layout.optionN=valueN</em>
<a name="162" href="#162">162</a> <em>    &lt;/pre></em>
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a> <em>    &lt;h3>Configuring loggers&lt;/h3></em>
<a name="165" href="#165">165</a> 
<a name="166" href="#166">166</a> <em>    &lt;p>The syntax for configuring the root logger is:</em>
<a name="167" href="#167">167</a> <em>    &lt;pre></em>
<a name="168" href="#168">168</a> <em>      log4j.rootLogger=[level], appenderName, appenderName, ...</em>
<a name="169" href="#169">169</a> <em>    &lt;/pre></em>
<a name="170" href="#170">170</a> 
<a name="171" href="#171">171</a> <em>    &lt;p>This syntax means that an optional &lt;em>level&lt;/em> can be</em>
<a name="172" href="#172">172</a> <em>    supplied followed by appender names separated by commas.</em>
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a> <em>    &lt;p>The level value can consist of the string values OFF, FATAL,</em>
<a name="175" href="#175">175</a> <em>    ERROR, WARN, INFO, DEBUG, ALL or a &lt;em>custom level&lt;/em> value. A</em>
<a name="176" href="#176">176</a> <em>    custom level value can be specified in the form</em>
<a name="177" href="#177">177</a> <em>    &lt;code>level#classname&lt;/code>.</em>
<a name="178" href="#178">178</a> 
<a name="179" href="#179">179</a> <em>    &lt;p>If a level value is specified, then the root level is set</em>
<a name="180" href="#180">180</a> <em>    to the corresponding level.  If no level value is specified,</em>
<a name="181" href="#181">181</a> <em>    then the root level remains untouched.</em>
<a name="182" href="#182">182</a> 
<a name="183" href="#183">183</a> <em>    &lt;p>The root logger can be assigned multiple appenders.</em>
<a name="184" href="#184">184</a> 
<a name="185" href="#185">185</a> <em>    &lt;p>Each &lt;i>appenderName&lt;/i> (separated by commas) will be added to</em>
<a name="186" href="#186">186</a> <em>    the root logger. The named appender is defined using the</em>
<a name="187" href="#187">187</a> <em>    appender syntax defined above.</em>
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a> <em>    &lt;p>For non-root categories the syntax is almost the same:</em>
<a name="190" href="#190">190</a> <em>    &lt;pre></em>
<a name="191" href="#191">191</a> <em>    log4j.logger.logger_name=[level|INHERITED|NULL], appenderName, appenderName, ...</em>
<a name="192" href="#192">192</a> <em>    &lt;/pre></em>
<a name="193" href="#193">193</a> 
<a name="194" href="#194">194</a> <em>    &lt;p>The meaning of the optional level value is discussed above</em>
<a name="195" href="#195">195</a> <em>    in relation to the root logger. In addition however, the value</em>
<a name="196" href="#196">196</a> <em>    INHERITED can be specified meaning that the named logger should</em>
<a name="197" href="#197">197</a> <em>    inherit its level from the logger hierarchy.</em>
<a name="198" href="#198">198</a> 
<a name="199" href="#199">199</a> <em>    &lt;p>If no level value is supplied, then the level of the</em>
<a name="200" href="#200">200</a> <em>    named logger remains untouched.</em>
<a name="201" href="#201">201</a> 
<a name="202" href="#202">202</a> <em>    &lt;p>By default categories inherit their level from the</em>
<a name="203" href="#203">203</a> <em>    hierarchy. However, if you set the level of a logger and later</em>
<a name="204" href="#204">204</a> <em>    decide that that logger should inherit its level, then you should</em>
<a name="205" href="#205">205</a> <em>    specify INHERITED as the value for the level value. NULL is a</em>
<a name="206" href="#206">206</a> <em>    synonym for INHERITED.</em>
<a name="207" href="#207">207</a> 
<a name="208" href="#208">208</a> <em>    &lt;p>Similar to the root logger syntax, each &lt;i>appenderName&lt;/i></em>
<a name="209" href="#209">209</a> <em>    (separated by commas) will be attached to the named logger.</em>
<a name="210" href="#210">210</a> 
<a name="211" href="#211">211</a> <em>    &lt;p>See the &lt;a href="../../../../manual.html#additivity">appender</em>
<a name="212" href="#212">212</a> <em>    additivity rule&lt;/a> in the user manual for the meaning of the</em>
<a name="213" href="#213">213</a> <em>    &lt;code>additivity&lt;/code> flag.</em>
<a name="214" href="#214">214</a> 
<a name="215" href="#215">215</a> <em>    &lt;h3>ObjectRenderers&lt;/h3></em>
<a name="216" href="#216">216</a> 
<a name="217" href="#217">217</a> <em>    You can customize the way message objects of a given type are</em>
<a name="218" href="#218">218</a> <em>    converted to String before being logged. This is done by</em>
<a name="219" href="#219">219</a> <em>    specifying an {@link org.apache.log4j.or.ObjectRenderer ObjectRenderer}</em>
<a name="220" href="#220">220</a> <em>    for the object type would like to customize.</em>
<a name="221" href="#221">221</a> 
<a name="222" href="#222">222</a> <em>    &lt;p>The syntax is:</em>
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a> <em>    &lt;pre></em>
<a name="225" href="#225">225</a> <em>    log4j.renderer.fully.qualified.name.of.rendered.class=fully.qualified.name.of.rendering.class</em>
<a name="226" href="#226">226</a> <em>    &lt;/pre></em>
<a name="227" href="#227">227</a> 
<a name="228" href="#228">228</a> <em>    As in,</em>
<a name="229" href="#229">229</a> <em>    &lt;pre></em>
<a name="230" href="#230">230</a> <em>    log4j.renderer.my.Fruit=my.FruitRenderer</em>
<a name="231" href="#231">231</a> <em>    &lt;/pre></em>
<a name="232" href="#232">232</a> 
<a name="233" href="#233">233</a> <em>    &lt;h3>Logger Factories&lt;/h3></em>
<a name="234" href="#234">234</a> 
<a name="235" href="#235">235</a> <em>    The usage of custom logger factories is discouraged and no longer</em>
<a name="236" href="#236">236</a> <em>    documented.</em>
<a name="237" href="#237">237</a> 
<a name="238" href="#238">238</a> <em>    &lt;h3>Resetting Hierarchy&lt;/h3></em>
<a name="239" href="#239">239</a> 
<a name="240" href="#240">240</a> <em>    The hierarchy will be reset before configuration when</em>
<a name="241" href="#241">241</a> <em>    log4j.reset=true is present in the properties file.</em>
<a name="242" href="#242">242</a> 
<a name="243" href="#243">243</a> <em>    &lt;h3>Example&lt;/h3></em>
<a name="244" href="#244">244</a> 
<a name="245" href="#245">245</a> <em>    &lt;p>An example configuration is given below. Other configuration</em>
<a name="246" href="#246">246</a> <em>    file examples are given in the &lt;code>examples&lt;/code> folder.</em>
<a name="247" href="#247">247</a> 
<a name="248" href="#248">248</a> <em>    &lt;pre></em>
<a name="249" href="#249">249</a> 
<a name="250" href="#250">250</a> <em>    # Set options for appender named "A1".</em>
<a name="251" href="#251">251</a> <em>    # Appender "A1" will be a SyslogAppender</em>
<a name="252" href="#252">252</a> <em>    log4j.appender.A1=org.apache.log4j.net.SyslogAppender</em>
<a name="253" href="#253">253</a> 
<a name="254" href="#254">254</a> <em>    # The syslog daemon resides on www.abc.net</em>
<a name="255" href="#255">255</a> <em>    log4j.appender.A1.SyslogHost=www.abc.net</em>
<a name="256" href="#256">256</a> 
<a name="257" href="#257">257</a> <em>    # A1's layout is a PatternLayout, using the conversion pattern</em>
<a name="258" href="#258">258</a> <em>    # &lt;b>%r %-5p %c{2} %M.%L %x - %m\n&lt;/b>. Thus, the log output will</em>
<a name="259" href="#259">259</a> <em>    # include # the relative time since the start of the application in</em>
<a name="260" href="#260">260</a> <em>    # milliseconds, followed by the level of the log request,</em>
<a name="261" href="#261">261</a> <em>    # followed by the two rightmost components of the logger name,</em>
<a name="262" href="#262">262</a> <em>    # followed by the callers method name, followed by the line number,</em>
<a name="263" href="#263">263</a> <em>    # the nested disgnostic context and finally the message itself.</em>
<a name="264" href="#264">264</a> <em>    # Refer to the documentation of {@link PatternLayout} for further information</em>
<a name="265" href="#265">265</a> <em>    # on the syntax of the ConversionPattern key.</em>
<a name="266" href="#266">266</a> <em>    log4j.appender.A1.layout=org.apache.log4j.PatternLayout</em>
<a name="267" href="#267">267</a> <em>    log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %c{2} %M.%L %x - %m\n</em>
<a name="268" href="#268">268</a> 
<a name="269" href="#269">269</a> <em>    # Set options for appender named "A2"</em>
<a name="270" href="#270">270</a> <em>    # A2 should be a RollingFileAppender, with maximum file size of 10 MB</em>
<a name="271" href="#271">271</a> <em>    # using at most one backup file. A2's layout is TTCC, using the</em>
<a name="272" href="#272">272</a> <em>    # ISO8061 date format with context printing enabled.</em>
<a name="273" href="#273">273</a> <em>    log4j.appender.A2=org.apache.log4j.RollingFileAppender</em>
<a name="274" href="#274">274</a> <em>    log4j.appender.A2.MaxFileSize=10MB</em>
<a name="275" href="#275">275</a> <em>    log4j.appender.A2.MaxBackupIndex=1</em>
<a name="276" href="#276">276</a> <em>    log4j.appender.A2.layout=org.apache.log4j.TTCCLayout</em>
<a name="277" href="#277">277</a> <em>    log4j.appender.A2.layout.ContextPrinting=enabled</em>
<a name="278" href="#278">278</a> <em>    log4j.appender.A2.layout.DateFormat=ISO8601</em>
<a name="279" href="#279">279</a> 
<a name="280" href="#280">280</a> <em>    # Root logger set to DEBUG using the A2 appender defined above.</em>
<a name="281" href="#281">281</a> <em>    log4j.rootLogger=DEBUG, A2</em>
<a name="282" href="#282">282</a> 
<a name="283" href="#283">283</a> <em>    # Logger definitions:</em>
<a name="284" href="#284">284</a> <em>    # The SECURITY logger inherits is level from root. However, it's output</em>
<a name="285" href="#285">285</a> <em>    # will go to A1 appender defined above. It's additivity is non-cumulative.</em>
<a name="286" href="#286">286</a> <em>    log4j.logger.SECURITY=INHERIT, A1</em>
<a name="287" href="#287">287</a> <em>    log4j.additivity.SECURITY=false</em>
<a name="288" href="#288">288</a> 
<a name="289" href="#289">289</a> <em>    # Only warnings or above will be logged for the logger "SECURITY.access".</em>
<a name="290" href="#290">290</a> <em>    # Output will go to A1.</em>
<a name="291" href="#291">291</a> <em>    log4j.logger.SECURITY.access=WARN</em>
<a name="292" href="#292">292</a> 
<a name="293" href="#293">293</a> 
<a name="294" href="#294">294</a> <em>    # The logger "class.of.the.day" inherits its level from the</em>
<a name="295" href="#295">295</a> <em>    # logger hierarchy.  Output will go to the appender's of the root</em>
<a name="296" href="#296">296</a> <em>    # logger, A2 in this case.</em>
<a name="297" href="#297">297</a> <em>    log4j.logger.class.of.the.day=INHERIT</em>
<a name="298" href="#298">298</a> <em>    &lt;/pre></em>
<a name="299" href="#299">299</a> 
<a name="300" href="#300">300</a> <em>    &lt;p>Refer to the &lt;b>setOption&lt;/b> method in each Appender and</em>
<a name="301" href="#301">301</a> <em>    Layout for class specific options.</em>
<a name="302" href="#302">302</a> 
<a name="303" href="#303">303</a> <em>    &lt;p>Use the &lt;code>#&lt;/code> or &lt;code>!&lt;/code> characters at the</em>
<a name="304" href="#304">304</a> <em>    beginning of a line for comments.</em>
<a name="305" href="#305">305</a> 
<a name="306" href="#306">306</a> <em>   &lt;p></em>
<a name="307" href="#307">307</a> <em>   @param configFileName The name of the configuration file where the</em>
<a name="308" href="#308">308</a> <em>   configuration information is stored.</em>
<a name="309" href="#309">309</a> 
<a name="310" href="#310">310</a> <em>  */</em>
<a name="311" href="#311">311</a>   <strong>public</strong>
<a name="312" href="#312">312</a>   <strong>void</strong> doConfigure(String configFileName, <a href="../../../org/apache/log4j/spi/LoggerRepository.html">LoggerRepository</a> hierarchy) {
<a name="313" href="#313">313</a>     Properties props = <strong>new</strong> Properties();
<a name="314" href="#314">314</a>     FileInputStream istream = <strong>null</strong>;
<a name="315" href="#315">315</a>     <strong>try</strong> {
<a name="316" href="#316">316</a>       istream = <strong>new</strong> FileInputStream(configFileName);
<a name="317" href="#317">317</a>       props.load(istream);
<a name="318" href="#318">318</a>       istream.close();
<a name="319" href="#319">319</a>     }
<a name="320" href="#320">320</a>     <strong>catch</strong> (Exception e) {
<a name="321" href="#321">321</a>       LogLog.error(<span class="string">"Could not read configuration file ["</span>+configFileName+<span class="string">"]."</span>, e);
<a name="322" href="#322">322</a>       LogLog.error(<span class="string">"Ignoring configuration file ["</span> + configFileName+<span class="string">"]."</span>);
<a name="323" href="#323">323</a>       <strong>return</strong>;
<a name="324" href="#324">324</a>     } <strong>finally</strong> {
<a name="325" href="#325">325</a>         <strong>if</strong>(istream != <strong>null</strong>) {
<a name="326" href="#326">326</a>             <strong>try</strong> {
<a name="327" href="#327">327</a>                 istream.close();
<a name="328" href="#328">328</a>             } <strong>catch</strong>(Throwable ignore) {
<a name="329" href="#329">329</a>             }
<a name="330" href="#330">330</a> 
<a name="331" href="#331">331</a>         }
<a name="332" href="#332">332</a>     }
<a name="333" href="#333">333</a>     <em class="comment">// If we reach here, then the config file is alright.</em>
<a name="334" href="#334">334</a>     doConfigure(props, hierarchy);
<a name="335" href="#335">335</a>   }
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>   <em>/**<em>*</em></em>
<a name="338" href="#338">338</a> <em>   */</em>
<a name="339" href="#339">339</a>   <strong>static</strong>
<a name="340" href="#340">340</a>   <strong>public</strong>
<a name="341" href="#341">341</a>   <strong>void</strong> configure(String configFilename) {
<a name="342" href="#342">342</a>     <strong>new</strong> <a href="../../../org/apache/log4j/PropertyConfigurator.html">PropertyConfigurator</a>().doConfigure(configFilename,
<a name="343" href="#343">343</a> 					   LogManager.getLoggerRepository());
<a name="344" href="#344">344</a>   }
<a name="345" href="#345">345</a> 
<a name="346" href="#346">346</a>   <em>/**<em>*</em></em>
<a name="347" href="#347">347</a> <em>     Read configuration options from url &lt;code>configURL&lt;/code>.</em>
<a name="348" href="#348">348</a> 
<a name="349" href="#349">349</a> <em>     @since 0.8.2</em>
<a name="350" href="#350">350</a> <em>   */</em>
<a name="351" href="#351">351</a>   <strong>public</strong>
<a name="352" href="#352">352</a>   <strong>static</strong>
<a name="353" href="#353">353</a>   <strong>void</strong> configure(java.net.URL configURL) {
<a name="354" href="#354">354</a>     <strong>new</strong> <a href="../../../org/apache/log4j/PropertyConfigurator.html">PropertyConfigurator</a>().doConfigure(configURL,
<a name="355" href="#355">355</a> 					   LogManager.getLoggerRepository());
<a name="356" href="#356">356</a>   }
<a name="357" href="#357">357</a> 
<a name="358" href="#358">358</a> 
<a name="359" href="#359">359</a>   <em>/**<em>*</em></em>
<a name="360" href="#360">360</a> <em>     Read configuration options from &lt;code>properties&lt;/code>.</em>
<a name="361" href="#361">361</a> 
<a name="362" href="#362">362</a> <em>     See {@link #doConfigure(String, LoggerRepository)} for the expected format.</em>
<a name="363" href="#363">363</a> <em>  */</em>
<a name="364" href="#364">364</a>   <strong>static</strong>
<a name="365" href="#365">365</a>   <strong>public</strong>
<a name="366" href="#366">366</a>   <strong>void</strong> configure(Properties properties) {
<a name="367" href="#367">367</a>     <strong>new</strong> <a href="../../../org/apache/log4j/PropertyConfigurator.html">PropertyConfigurator</a>().doConfigure(properties,
<a name="368" href="#368">368</a> 					   LogManager.getLoggerRepository());
<a name="369" href="#369">369</a>   }
<a name="370" href="#370">370</a> 
<a name="371" href="#371">371</a>   <em>/**<em>*</em></em>
<a name="372" href="#372">372</a> <em>     Like {@link #configureAndWatch(String, long)} except that the</em>
<a name="373" href="#373">373</a> <em>     default delay as defined by {@link FileWatchdog#DEFAULT_DELAY} is</em>
<a name="374" href="#374">374</a> <em>     used.</em>
<a name="375" href="#375">375</a> 
<a name="376" href="#376">376</a> <em>     @param configFilename A file in key=value format.</em>
<a name="377" href="#377">377</a> 
<a name="378" href="#378">378</a> <em>  */</em>
<a name="379" href="#379">379</a>   <strong>static</strong>
<a name="380" href="#380">380</a>   <strong>public</strong>
<a name="381" href="#381">381</a>   <strong>void</strong> configureAndWatch(String configFilename) {
<a name="382" href="#382">382</a>     configureAndWatch(configFilename, FileWatchdog.DEFAULT_DELAY);
<a name="383" href="#383">383</a>   }
<a name="384" href="#384">384</a> 
<a name="385" href="#385">385</a> 
<a name="386" href="#386">386</a>   <em>/**<em>*</em></em>
<a name="387" href="#387">387</a> <em>     Read the configuration file &lt;code>configFilename&lt;/code> if it</em>
<a name="388" href="#388">388</a> <em>     exists. Moreover, a thread will be created that will periodically</em>
<a name="389" href="#389">389</a> <em>     check if &lt;code>configFilename&lt;/code> has been created or</em>
<a name="390" href="#390">390</a> <em>     modified. The period is determined by the &lt;code>delay&lt;/code></em>
<a name="391" href="#391">391</a> <em>     argument. If a change or file creation is detected, then</em>
<a name="392" href="#392">392</a> <em>     &lt;code>configFilename&lt;/code> is read to configure log4j.</em>
<a name="393" href="#393">393</a> 
<a name="394" href="#394">394</a> <em>      @param configFilename A file in key=value format.</em>
<a name="395" href="#395">395</a> <em>      @param delay The delay in milliseconds to wait between each check.</em>
<a name="396" href="#396">396</a> <em>  */</em>
<a name="397" href="#397">397</a>   <strong>static</strong>
<a name="398" href="#398">398</a>   <strong>public</strong>
<a name="399" href="#399">399</a>   <strong>void</strong> configureAndWatch(String configFilename, <strong>long</strong> delay) {
<a name="400" href="#400">400</a>     PropertyWatchdog pdog = <strong>new</strong> PropertyWatchdog(configFilename);
<a name="401" href="#401">401</a>     pdog.setDelay(delay);
<a name="402" href="#402">402</a>     pdog.start();
<a name="403" href="#403">403</a>   }
<a name="404" href="#404">404</a> 
<a name="405" href="#405">405</a> 
<a name="406" href="#406">406</a>   <em>/**<em>*</em></em>
<a name="407" href="#407">407</a> <em>     Read configuration options from &lt;code>properties&lt;/code>.</em>
<a name="408" href="#408">408</a> 
<a name="409" href="#409">409</a> <em>     See {@link #doConfigure(String, LoggerRepository)} for the expected format.</em>
<a name="410" href="#410">410</a> <em>  */</em>
<a name="411" href="#411">411</a>   <strong>public</strong>
<a name="412" href="#412">412</a>   <strong>void</strong> doConfigure(Properties properties, <a href="../../../org/apache/log4j/spi/LoggerRepository.html">LoggerRepository</a> hierarchy) {
<a name="413" href="#413">413</a>     String value = properties.getProperty(LogLog.DEBUG_KEY);
<a name="414" href="#414">414</a>     <strong>if</strong>(value == <strong>null</strong>) {
<a name="415" href="#415">415</a>       value = properties.getProperty(<span class="string">"log4j.configDebug"</span>);
<a name="416" href="#416">416</a>       <strong>if</strong>(value != <strong>null</strong>)
<a name="417" href="#417">417</a> 	LogLog.warn(<span class="string">"[log4j.configDebug] is deprecated. Use [log4j.debug] instead."</span>);
<a name="418" href="#418">418</a>     }
<a name="419" href="#419">419</a> 
<a name="420" href="#420">420</a>     <strong>if</strong>(value != <strong>null</strong>) {
<a name="421" href="#421">421</a>       LogLog.setInternalDebugging(OptionConverter.toBoolean(value, <strong>true</strong>));
<a name="422" href="#422">422</a>     }
<a name="423" href="#423">423</a> 
<a name="424" href="#424">424</a>       <em class="comment">//</em>
<a name="425" href="#425">425</a>       <em class="comment">//   if log4j.reset=true then</em>
<a name="426" href="#426">426</a>       <em class="comment">//        reset hierarchy</em>
<a name="427" href="#427">427</a>     String reset = properties.getProperty(RESET_KEY);
<a name="428" href="#428">428</a>     <strong>if</strong> (reset != <strong>null</strong> &amp;&amp; OptionConverter.toBoolean(reset, false)) {
<a name="429" href="#429">429</a>           hierarchy.resetConfiguration();
<a name="430" href="#430">430</a>     }
<a name="431" href="#431">431</a> 
<a name="432" href="#432">432</a>     String thresholdStr = OptionConverter.findAndSubst(THRESHOLD_PREFIX,
<a name="433" href="#433">433</a> 						       properties);
<a name="434" href="#434">434</a>     <strong>if</strong>(thresholdStr != <strong>null</strong>) {
<a name="435" href="#435">435</a>       hierarchy.setThreshold(OptionConverter.toLevel(thresholdStr,
<a name="436" href="#436">436</a> 						     (Level) Level.ALL));
<a name="437" href="#437">437</a>       LogLog.debug(<span class="string">"Hierarchy threshold set to ["</span>+hierarchy.getThreshold()+<span class="string">"]."</span>);
<a name="438" href="#438">438</a>     }
<a name="439" href="#439">439</a> 
<a name="440" href="#440">440</a>     configureRootCategory(properties, hierarchy);
<a name="441" href="#441">441</a>     configureLoggerFactory(properties);
<a name="442" href="#442">442</a>     parseCatsAndRenderers(properties, hierarchy);
<a name="443" href="#443">443</a> 
<a name="444" href="#444">444</a>     LogLog.debug(<span class="string">"Finished configuring."</span>);
<a name="445" href="#445">445</a>     <em class="comment">// We don't want to hold references to appenders preventing their</em>
<a name="446" href="#446">446</a>     <em class="comment">// garbage collection.</em>
<a name="447" href="#447">447</a>     registry.clear();
<a name="448" href="#448">448</a>   }
<a name="449" href="#449">449</a> 
<a name="450" href="#450">450</a>   <em>/**<em>*</em></em>
<a name="451" href="#451">451</a> <em>     Read configuration options from url &lt;code>configURL&lt;/code>.</em>
<a name="452" href="#452">452</a> <em>   */</em>
<a name="453" href="#453">453</a>   <strong>public</strong>
<a name="454" href="#454">454</a>   <strong>void</strong> doConfigure(java.net.URL configURL, <a href="../../../org/apache/log4j/spi/LoggerRepository.html">LoggerRepository</a> hierarchy) {
<a name="455" href="#455">455</a>     Properties props = <strong>new</strong> Properties();
<a name="456" href="#456">456</a>     LogLog.debug(<span class="string">"Reading configuration from URL "</span> + configURL);
<a name="457" href="#457">457</a>     InputStream istream = <strong>null</strong>;
<a name="458" href="#458">458</a>     <strong>try</strong> {
<a name="459" href="#459">459</a>       istream = configURL.openStream();
<a name="460" href="#460">460</a>       props.load(istream);
<a name="461" href="#461">461</a>     }
<a name="462" href="#462">462</a>     <strong>catch</strong> (Exception e) {
<a name="463" href="#463">463</a>       LogLog.error(<span class="string">"Could not read configuration file from URL ["</span> + configURL
<a name="464" href="#464">464</a> 		   + <span class="string">"]."</span>, e);
<a name="465" href="#465">465</a>       LogLog.error(<span class="string">"Ignoring configuration file ["</span> + configURL +<span class="string">"]."</span>);
<a name="466" href="#466">466</a>       <strong>return</strong>;
<a name="467" href="#467">467</a>     }
<a name="468" href="#468">468</a>     <strong>finally</strong> {
<a name="469" href="#469">469</a>         <strong>if</strong> (istream != <strong>null</strong>) {
<a name="470" href="#470">470</a>             <strong>try</strong> {
<a name="471" href="#471">471</a>                 istream.close();
<a name="472" href="#472">472</a>             } <strong>catch</strong>(Exception ignore) {
<a name="473" href="#473">473</a>             }
<a name="474" href="#474">474</a>         }
<a name="475" href="#475">475</a>     }
<a name="476" href="#476">476</a>     doConfigure(props, hierarchy);
<a name="477" href="#477">477</a>   }
<a name="478" href="#478">478</a> 
<a name="479" href="#479">479</a> 
<a name="480" href="#480">480</a>   <em class="comment">// --------------------------------------------------------------------------</em>
<a name="481" href="#481">481</a>   <em class="comment">// Internal stuff</em>
<a name="482" href="#482">482</a>   <em class="comment">// --------------------------------------------------------------------------</em>
<a name="483" href="#483">483</a> 
<a name="484" href="#484">484</a>   <em>/**<em>*</em></em>
<a name="485" href="#485">485</a> <em>     Check the provided &lt;code>Properties&lt;/code> object for a</em>
<a name="486" href="#486">486</a> <em>     {@link org.apache.log4j.spi.LoggerFactory LoggerFactory}</em>
<a name="487" href="#487">487</a> <em>     entry specified by {@link #LOGGER_FACTORY_KEY}.  If such an entry</em>
<a name="488" href="#488">488</a> <em>     exists, an attempt is made to create an instance using the default</em>
<a name="489" href="#489">489</a> <em>     constructor.  This instance is used for subsequent Category creations</em>
<a name="490" href="#490">490</a> <em>     within this configurator.</em>
<a name="491" href="#491">491</a> 
<a name="492" href="#492">492</a> <em>     @see #parseCatsAndRenderers</em>
<a name="493" href="#493">493</a> <em>   */</em>
<a name="494" href="#494">494</a>   <strong>protected</strong> <strong>void</strong> configureLoggerFactory(Properties props) {
<a name="495" href="#495">495</a>     String factoryClassName = OptionConverter.findAndSubst(LOGGER_FACTORY_KEY,
<a name="496" href="#496">496</a> 							   props);
<a name="497" href="#497">497</a>     <strong>if</strong>(factoryClassName != <strong>null</strong>) {
<a name="498" href="#498">498</a>       LogLog.debug(<span class="string">"Setting category factory to ["</span>+factoryClassName+<span class="string">"]."</span>);
<a name="499" href="#499">499</a>       loggerFactory = (LoggerFactory)
<a name="500" href="#500">500</a> 	          OptionConverter.instantiateByClassName(factoryClassName,
<a name="501" href="#501">501</a> 							 LoggerFactory.<strong>class</strong>,
<a name="502" href="#502">502</a> 							 loggerFactory);
<a name="503" href="#503">503</a>       PropertySetter.setProperties(loggerFactory, props, FACTORY_PREFIX + <span class="string">"."</span>);
<a name="504" href="#504">504</a>     }
<a name="505" href="#505">505</a>   }
<a name="506" href="#506">506</a> 
<a name="507" href="#507">507</a>   <em class="comment">/*</em>
<a name="508" href="#508">508</a> <em class="comment">  void configureOptionHandler(OptionHandler oh, String prefix,</em>
<a name="509" href="#509">509</a> <em class="comment">			      Properties props) {</em>
<a name="510" href="#510">510</a> <em class="comment">    String[] options = oh.getOptionStrings();</em>
<a name="511" href="#511">511</a> <em class="comment">    if(options == null)</em>
<a name="512" href="#512">512</a> <em class="comment">      return;</em>
<a name="513" href="#513">513</a> 
<a name="514" href="#514">514</a> <em class="comment">    String value;</em>
<a name="515" href="#515">515</a> <em class="comment">    for(int i = 0; i &lt; options.length; i++) {</em>
<a name="516" href="#516">516</a> <em class="comment">      value =  OptionConverter.findAndSubst(prefix + options[i], props);</em>
<a name="517" href="#517">517</a> <em class="comment">      LogLog.debug(</em>
<a name="518" href="#518">518</a> <em class="comment">         "Option " + options[i] + "=[" + (value == null? "N/A" : value)+"].");</em>
<a name="519" href="#519">519</a> <em class="comment">      // Some option handlers assume that null value are not passed to them.</em>
<a name="520" href="#520">520</a> <em class="comment">      // So don't remove this check</em>
<a name="521" href="#521">521</a> <em class="comment">      if(value != null) {</em>
<a name="522" href="#522">522</a> <em class="comment">	oh.setOption(options[i], value);</em>
<a name="523" href="#523">523</a> <em class="comment">      }</em>
<a name="524" href="#524">524</a> <em class="comment">    }</em>
<a name="525" href="#525">525</a> <em class="comment">    oh.activateOptions();</em>
<a name="526" href="#526">526</a> <em class="comment">  }</em>
<a name="527" href="#527">527</a> <em class="comment">  */</em>
<a name="528" href="#528">528</a> 
<a name="529" href="#529">529</a> 
<a name="530" href="#530">530</a>   <strong>void</strong> configureRootCategory(Properties props, <a href="../../../org/apache/log4j/spi/LoggerRepository.html">LoggerRepository</a> hierarchy) {
<a name="531" href="#531">531</a>     String effectiveFrefix = ROOT_LOGGER_PREFIX;
<a name="532" href="#532">532</a>     String value = OptionConverter.findAndSubst(ROOT_LOGGER_PREFIX, props);
<a name="533" href="#533">533</a> 
<a name="534" href="#534">534</a>     <strong>if</strong>(value == <strong>null</strong>) {
<a name="535" href="#535">535</a>       value = OptionConverter.findAndSubst(ROOT_CATEGORY_PREFIX, props);
<a name="536" href="#536">536</a>       effectiveFrefix = ROOT_CATEGORY_PREFIX;
<a name="537" href="#537">537</a>     }
<a name="538" href="#538">538</a> 
<a name="539" href="#539">539</a>     <strong>if</strong>(value == <strong>null</strong>)
<a name="540" href="#540">540</a>       LogLog.debug(<span class="string">"Could not find root logger information. Is this OK?"</span>);
<a name="541" href="#541">541</a>     <strong>else</strong> {
<a name="542" href="#542">542</a>       <a href="../../../org/apache/log4j/Logger.html">Logger</a> root = hierarchy.getRootLogger();
<a name="543" href="#543">543</a>       <strong>synchronized</strong>(root) {
<a name="544" href="#544">544</a> 	parseCategory(props, root, effectiveFrefix, INTERNAL_ROOT_NAME, value);
<a name="545" href="#545">545</a>       }
<a name="546" href="#546">546</a>     }
<a name="547" href="#547">547</a>   }
<a name="548" href="#548">548</a> 
<a name="549" href="#549">549</a> 
<a name="550" href="#550">550</a>   <em>/**<em>*</em></em>
<a name="551" href="#551">551</a> <em>     Parse non-root elements, such non-root categories and renderers.</em>
<a name="552" href="#552">552</a> <em>  */</em>
<a name="553" href="#553">553</a>   <strong>protected</strong>
<a name="554" href="#554">554</a>   <strong>void</strong> parseCatsAndRenderers(Properties props, <a href="../../../org/apache/log4j/spi/LoggerRepository.html">LoggerRepository</a> hierarchy) {
<a name="555" href="#555">555</a>     Enumeration enumeration = props.propertyNames();
<a name="556" href="#556">556</a>     <strong>while</strong>(enumeration.hasMoreElements()) {
<a name="557" href="#557">557</a>       String key = (String) enumeration.nextElement();
<a name="558" href="#558">558</a>       <strong>if</strong>(key.startsWith(CATEGORY_PREFIX) || key.startsWith(LOGGER_PREFIX)) {
<a name="559" href="#559">559</a> 	String loggerName = <strong>null</strong>;
<a name="560" href="#560">560</a> 	<strong>if</strong>(key.startsWith(CATEGORY_PREFIX)) {
<a name="561" href="#561">561</a> 	  loggerName = key.substring(CATEGORY_PREFIX.length());
<a name="562" href="#562">562</a> 	} <strong>else</strong> <strong>if</strong>(key.startsWith(LOGGER_PREFIX)) {
<a name="563" href="#563">563</a> 	  loggerName = key.substring(LOGGER_PREFIX.length());
<a name="564" href="#564">564</a> 	}
<a name="565" href="#565">565</a> 	String value =  OptionConverter.findAndSubst(key, props);
<a name="566" href="#566">566</a> 	Logger logger = hierarchy.getLogger(loggerName, loggerFactory);
<a name="567" href="#567">567</a> 	<strong>synchronized</strong>(logger) {
<a name="568" href="#568">568</a> 	  parseCategory(props, logger, key, loggerName, value);
<a name="569" href="#569">569</a> 	  parseAdditivityForLogger(props, logger, loggerName);
<a name="570" href="#570">570</a> 	}
<a name="571" href="#571">571</a>       } <strong>else</strong> <strong>if</strong>(key.startsWith(RENDERER_PREFIX)) {
<a name="572" href="#572">572</a> 	String renderedClass = key.substring(RENDERER_PREFIX.length());
<a name="573" href="#573">573</a> 	String renderingClass = OptionConverter.findAndSubst(key, props);
<a name="574" href="#574">574</a> 	<strong>if</strong>(hierarchy instanceof <a href="../../../org/apache/log4j/spi/RendererSupport.html">RendererSupport</a>) {
<a name="575" href="#575">575</a> 	  RendererMap.addRenderer((RendererSupport) hierarchy, renderedClass,
<a name="576" href="#576">576</a> 				  renderingClass);
<a name="577" href="#577">577</a> 	}
<a name="578" href="#578">578</a>       }
<a name="579" href="#579">579</a>     }
<a name="580" href="#580">580</a>   }
<a name="581" href="#581">581</a> 
<a name="582" href="#582">582</a>   <em>/**<em>*</em></em>
<a name="583" href="#583">583</a> <em>     Parse the additivity option for a non-root category.</em>
<a name="584" href="#584">584</a> <em>   */</em>
<a name="585" href="#585">585</a>   <strong>void</strong> parseAdditivityForLogger(Properties props, <a href="../../../org/apache/log4j/Logger.html">Logger</a> cat,
<a name="586" href="#586">586</a> 				  String loggerName) {
<a name="587" href="#587">587</a>     String value = OptionConverter.findAndSubst(ADDITIVITY_PREFIX + loggerName,
<a name="588" href="#588">588</a> 					     props);
<a name="589" href="#589">589</a>     LogLog.debug(<span class="string">"Handling "</span>+ADDITIVITY_PREFIX + loggerName+<span class="string">"=["</span>+value+<span class="string">"]"</span>);
<a name="590" href="#590">590</a>     <em class="comment">// touch additivity only if necessary</em>
<a name="591" href="#591">591</a>     <strong>if</strong>((value != <strong>null</strong>) &amp;&amp; (!value.equals(<span class="string">""</span>))) {
<a name="592" href="#592">592</a>       <strong>boolean</strong> additivity = OptionConverter.toBoolean(value, <strong>true</strong>);
<a name="593" href="#593">593</a>       LogLog.debug(<span class="string">"Setting additivity for \&quot;"</span>+loggerName+<span class="string">"\&quot; to "</span>+
<a name="594" href="#594">594</a> 		   additivity);
<a name="595" href="#595">595</a>       cat.setAdditivity(additivity);
<a name="596" href="#596">596</a>     }
<a name="597" href="#597">597</a>   }
<a name="598" href="#598">598</a> 
<a name="599" href="#599">599</a>   <em>/**<em>*</em></em>
<a name="600" href="#600">600</a> <em>     This method must work for the root category as well.</em>
<a name="601" href="#601">601</a> <em>   */</em>
<a name="602" href="#602">602</a>   <strong>void</strong> parseCategory(Properties props, <a href="../../../org/apache/log4j/Logger.html">Logger</a> logger, String optionKey,
<a name="603" href="#603">603</a> 		     String loggerName, String value) {
<a name="604" href="#604">604</a> 
<a name="605" href="#605">605</a>     LogLog.debug(<span class="string">"Parsing for ["</span> +loggerName +<span class="string">"] with value=["</span> + value+<span class="string">"]."</span>);
<a name="606" href="#606">606</a>     <em class="comment">// We must skip over ',' but not white space</em>
<a name="607" href="#607">607</a>     StringTokenizer st = <strong>new</strong> StringTokenizer(value, <span class="string">","</span>);
<a name="608" href="#608">608</a> 
<a name="609" href="#609">609</a>     <em class="comment">// If value is not in the form ", appender.." or "", then we should set</em>
<a name="610" href="#610">610</a>     <em class="comment">// the level of the loggeregory.</em>
<a name="611" href="#611">611</a> 
<a name="612" href="#612">612</a>     <strong>if</strong>(!(value.startsWith(<span class="string">","</span>) || value.equals(<span class="string">""</span>))) {
<a name="613" href="#613">613</a> 
<a name="614" href="#614">614</a>       <em class="comment">// just to be on the safe side...</em>
<a name="615" href="#615">615</a>       <strong>if</strong>(!st.hasMoreTokens())
<a name="616" href="#616">616</a> 	<strong>return</strong>;
<a name="617" href="#617">617</a> 
<a name="618" href="#618">618</a>       String levelStr = st.nextToken();
<a name="619" href="#619">619</a>       LogLog.debug(<span class="string">"Level token is ["</span> + levelStr + <span class="string">"]."</span>);
<a name="620" href="#620">620</a> 
<a name="621" href="#621">621</a>       <em class="comment">// If the level value is inherited, set category level value to</em>
<a name="622" href="#622">622</a>       <em class="comment">// null. We also check that the user has not specified inherited for the</em>
<a name="623" href="#623">623</a>       <em class="comment">// root category.</em>
<a name="624" href="#624">624</a>       <strong>if</strong>(INHERITED.equalsIgnoreCase(levelStr) || 
<a name="625" href="#625">625</a>  	                                  NULL.equalsIgnoreCase(levelStr)) {
<a name="626" href="#626">626</a> 	<strong>if</strong>(loggerName.equals(INTERNAL_ROOT_NAME)) {
<a name="627" href="#627">627</a> 	  LogLog.warn(<span class="string">"The root logger cannot be set to null."</span>);
<a name="628" href="#628">628</a> 	} <strong>else</strong> {
<a name="629" href="#629">629</a> 	  logger.setLevel(<strong>null</strong>);
<a name="630" href="#630">630</a> 	}
<a name="631" href="#631">631</a>       } <strong>else</strong> {
<a name="632" href="#632">632</a> 	logger.setLevel(OptionConverter.toLevel(levelStr, (Level) Level.DEBUG));
<a name="633" href="#633">633</a>       }
<a name="634" href="#634">634</a>       LogLog.debug(<span class="string">"Category "</span> + loggerName + <span class="string">" set to "</span> + logger.getLevel());
<a name="635" href="#635">635</a>     }
<a name="636" href="#636">636</a> 
<a name="637" href="#637">637</a>     <em class="comment">// Begin by removing all existing appenders.</em>
<a name="638" href="#638">638</a>     logger.removeAllAppenders();
<a name="639" href="#639">639</a> 
<a name="640" href="#640">640</a>     <a href="../../../org/apache/log4j/Appender.html">Appender</a> appender;
<a name="641" href="#641">641</a>     String appenderName;
<a name="642" href="#642">642</a>     <strong>while</strong>(st.hasMoreTokens()) {
<a name="643" href="#643">643</a>       appenderName = st.nextToken().trim();
<a name="644" href="#644">644</a>       <strong>if</strong>(appenderName == <strong>null</strong> || appenderName.equals(<span class="string">","</span>))
<a name="645" href="#645">645</a> 	<strong>continue</strong>;
<a name="646" href="#646">646</a>       LogLog.debug(<span class="string">"Parsing appender named \&quot;"</span> + appenderName +<span class="string">"\&quot;."</span>);
<a name="647" href="#647">647</a>       appender = parseAppender(props, appenderName);
<a name="648" href="#648">648</a>       <strong>if</strong>(appender != <strong>null</strong>) {
<a name="649" href="#649">649</a> 	logger.addAppender(appender);
<a name="650" href="#650">650</a>       }
<a name="651" href="#651">651</a>     }
<a name="652" href="#652">652</a>   }
<a name="653" href="#653">653</a> 
<a name="654" href="#654">654</a>   <a href="../../../org/apache/log4j/Appender.html">Appender</a> parseAppender(Properties props, String appenderName) {
<a name="655" href="#655">655</a>     <a href="../../../org/apache/log4j/Appender.html">Appender</a> appender = registryGet(appenderName);
<a name="656" href="#656">656</a>     <strong>if</strong>((appender != <strong>null</strong>)) {
<a name="657" href="#657">657</a>       LogLog.debug(<span class="string">"Appender \&quot;"</span> + appenderName + <span class="string">"\&quot; was already parsed."</span>);
<a name="658" href="#658">658</a>       <strong>return</strong> appender;
<a name="659" href="#659">659</a>     }
<a name="660" href="#660">660</a>     <em class="comment">// Appender was not previously initialized.</em>
<a name="661" href="#661">661</a>     String prefix = APPENDER_PREFIX + appenderName;
<a name="662" href="#662">662</a>     String layoutPrefix = prefix + <span class="string">".layout"</span>;
<a name="663" href="#663">663</a> 
<a name="664" href="#664">664</a>     appender = (Appender) OptionConverter.instantiateByKey(props, prefix,
<a name="665" href="#665">665</a> 					      org.apache.log4j.Appender.<strong>class</strong>,
<a name="666" href="#666">666</a> 					      <strong>null</strong>);
<a name="667" href="#667">667</a>     <strong>if</strong>(appender == <strong>null</strong>) {
<a name="668" href="#668">668</a>       LogLog.error(
<a name="669" href="#669">669</a>               <span class="string">"Could not instantiate appender named \&quot;"</span> + appenderName+<span class="string">"\&quot;."</span>);
<a name="670" href="#670">670</a>       <strong>return</strong> <strong>null</strong>;
<a name="671" href="#671">671</a>     }
<a name="672" href="#672">672</a>     appender.setName(appenderName);
<a name="673" href="#673">673</a> 
<a name="674" href="#674">674</a>     <strong>if</strong>(appender instanceof <a href="../../../org/apache/log4j/spi/OptionHandler.html">OptionHandler</a>) {
<a name="675" href="#675">675</a>       <strong>if</strong>(appender.requiresLayout()) {
<a name="676" href="#676">676</a> 	Layout layout = (Layout) OptionConverter.instantiateByKey(props,
<a name="677" href="#677">677</a> 								  layoutPrefix,
<a name="678" href="#678">678</a> 								  Layout.<strong>class</strong>,
<a name="679" href="#679">679</a> 								  <strong>null</strong>);
<a name="680" href="#680">680</a> 	<strong>if</strong>(layout != <strong>null</strong>) {
<a name="681" href="#681">681</a> 	  appender.setLayout(layout);
<a name="682" href="#682">682</a> 	  LogLog.debug(<span class="string">"Parsing layout options for \&quot;"</span> + appenderName +<span class="string">"\&quot;."</span>);
<a name="683" href="#683">683</a> 	  <em class="comment">//configureOptionHandler(layout, layoutPrefix + ".", props);</em>
<a name="684" href="#684">684</a>           PropertySetter.setProperties(layout, props, layoutPrefix + <span class="string">"."</span>);
<a name="685" href="#685">685</a> 	  LogLog.debug(<span class="string">"End of parsing for \&quot;"</span> + appenderName +<span class="string">"\&quot;."</span>);
<a name="686" href="#686">686</a> 	}
<a name="687" href="#687">687</a>       }
<a name="688" href="#688">688</a>       <em class="comment">//configureOptionHandler((OptionHandler) appender, prefix + ".", props);</em>
<a name="689" href="#689">689</a>       PropertySetter.setProperties(appender, props, prefix + <span class="string">"."</span>);
<a name="690" href="#690">690</a>       LogLog.debug(<span class="string">"Parsed \&quot;"</span> + appenderName +<span class="string">"\&quot; options."</span>);
<a name="691" href="#691">691</a>     }
<a name="692" href="#692">692</a>     registryPut(appender);
<a name="693" href="#693">693</a>     <strong>return</strong> appender;
<a name="694" href="#694">694</a>   }
<a name="695" href="#695">695</a> 
<a name="696" href="#696">696</a> 
<a name="697" href="#697">697</a>   <strong>void</strong>  registryPut(Appender appender) {
<a name="698" href="#698">698</a>     registry.put(appender.getName(), appender);
<a name="699" href="#699">699</a>   }
<a name="700" href="#700">700</a> 
<a name="701" href="#701">701</a>   <a href="../../../org/apache/log4j/Appender.html">Appender</a> registryGet(String name) {
<a name="702" href="#702">702</a>     <strong>return</strong> (Appender) registry.get(name);
<a name="703" href="#703">703</a>   }
<a name="704" href="#704">704</a> }
<a name="705" href="#705">705</a> 
<a name="706" href="#706">706</a> <strong>class</strong> PropertyWatchdog <strong>extends</strong> <a href="../../../org/apache/log4j/helpers/FileWatchdog.html">FileWatchdog</a> {
<a name="707" href="#707">707</a> 
<a name="708" href="#708">708</a>   PropertyWatchdog(String filename) {
<a name="709" href="#709">709</a>     <strong>super</strong>(filename);
<a name="710" href="#710">710</a>   }
<a name="711" href="#711">711</a> 
<a name="712" href="#712">712</a>   <em>/**<em>*</em></em>
<a name="713" href="#713">713</a> <em>     Call {@link PropertyConfigurator#configure(String)} with the</em>
<a name="714" href="#714">714</a> <em>     &lt;code>filename&lt;/code> to reconfigure log4j. */</em>
<a name="715" href="#715">715</a>   <strong>public</strong>
<a name="716" href="#716">716</a>   <strong>void</strong> doOnChange() {
<a name="717" href="#717">717</a>     <strong>new</strong> <a href="../../../org/apache/log4j/PropertyConfigurator.html">PropertyConfigurator</a>().doConfigure(filename,
<a name="718" href="#718">718</a> 					   LogManager.getLoggerRepository());
<a name="719" href="#719">719</a>   }
<a name="720" href="#720">720</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

